sdk/samples/all in on code/Visual Studio 2010/CppShellExtCopyHookHandler/Reg.cpp

   1 /****************************** Module Header ******************************\
   2 Module Name:  Reg.cpp
   3 Project:      CppShellExtCopyHookHandler
   4 Copyright (c) Microsoft Corporation.
   5
   6 The file implements the reusable helper functions to register and unregister
   7 in-process COM components and shell copy hook handlers in the registry.
   8
   9 RegisterInprocServer - register the in-process component in the registry.
  10 UnregisterInprocServer - unregister the in-process component in the registry.
  11 RegisterShellExtFolderCopyHookHandler - register the folder copy hook handler.
  12 UnregisterShellExtFolderCopyHookHandler - unregister the copy hook handler.
  13
  14 This source is subject to the Microsoft Public License.
  15 See http://www.microsoft.com/opensource/licenses.mspx#Ms-PL.
  16 All other rights reserved.
  17
  18 THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
  19 EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
  20 WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
  21 \***************************************************************************/
  22
  23 #include "Reg.h"
  24 #include <strsafe.h>
  25
  26
  27 #pragma region Registry Helper Functions
  28
  29 //
  30 //   FUNCTION: SetHKCRRegistryKeyAndValue
  31 //
  32 //   PURPOSE: The function creates a HKCR registry key and sets the specified
  33 //   registry value.
  34 //
  35 //   PARAMETERS:
  36 //   * pszSubKey - specifies the registry key under HKCR. If the key does not
  37 //     exist, the function will create the registry key.
  38 //   * pszValueName - specifies the registry value to be set. If pszValueName
  39 //     is NULL, the function will set the default value.
  40 //   * pszData - specifies the string data of the registry value.
  41 //
  42 //   RETURN VALUE:
  43 //   If the function succeeds, it returns S_OK. Otherwise, it returns an
  44 //   HRESULT error code.
  45 //
  46 HRESULT SetHKCRRegistryKeyAndValue(PCWSTR pszSubKey, PCWSTR pszValueName,
  47     PCWSTR pszData)
  48 {
  49     HRESULT hr;
  50     HKEY hKey = NULL;
  51
  52     // Creates the specified registry key. If the key already exists, the
  53     // function opens it.
  54     hr = HRESULT_FROM_WIN32(RegCreateKeyEx(HKEY_CLASSES_ROOT, pszSubKey, 0,
  55         NULL, REG_OPTION_NON_VOLATILE, KEY_WRITE, NULL, &hKey, NULL));
  56
  57     if (SUCCEEDED(hr))
  58     {
  59         if (pszData != NULL)
  60         {
  61             // Set the specified value of the key.
  62             DWORD cbData = lstrlen(pszData) * sizeof(*pszData);
  63             hr = HRESULT_FROM_WIN32(RegSetValueEx(hKey, pszValueName, 0,
  64                 REG_SZ, reinterpret_cast<const BYTE *>(pszData), cbData));
  65         }
  66
  67         RegCloseKey(hKey);
  68     }
  69
  70     return hr;
  71 }
  72
  73 #pragma endregion
  74
  75
  76 //
  77 //   FUNCTION: RegisterInprocServer
  78 //
  79 //   PURPOSE: Register the in-process component in the registry.
  80 //
  81 //   PARAMETERS:
  82 //   * pszModule - Path of the module that contains the component
  83 //   * clsid - Class ID of the component
  84 //   * pszFriendlyName - Friendly name
  85 //   * pszThreadModel - Threading model
  86 //
  87 //   NOTE: The function creates the HKCR\CLSID\{<CLSID>} key in the registry.
  88 //
  89 //   HKCR
  90 //   {
  91 //      NoRemove CLSID
  92 //      {
  93 //          ForceRemove {<CLSID>} = s '<Friendly Name>'
  94 //          {
  95 //              InprocServer32 = s '%MODULE%'
  96 //              {
  97 //                  val ThreadingModel = s '<Thread Model>'
  98 //              }
  99 //          }
 100 //      }
 101 //   }
 102 //
 103 HRESULT RegisterInprocServer(PCWSTR pszModule, const CLSID& clsid,
 104     PCWSTR pszFriendlyName, PCWSTR pszThreadModel)
 105 {
 106     if (pszModule == NULL || pszThreadModel == NULL)
 107     {
 108         return E_INVALIDARG;
 109     }
 110
 111     HRESULT hr;
 112
 113     wchar_t szCLSID[MAX_PATH];
 114     StringFromGUID2(clsid, szCLSID, ARRAYSIZE(szCLSID));
 115
 116     wchar_t szSubkey[MAX_PATH];
 117
 118     // Create the HKCR\CLSID\{<CLSID>} key.
 119     hr = StringCchPrintf(szSubkey, ARRAYSIZE(szSubkey), L"CLSID\\%s", szCLSID);
 120     if (SUCCEEDED(hr))
 121     {
 122         hr = SetHKCRRegistryKeyAndValue(szSubkey, NULL, pszFriendlyName);
 123
 124         // Create the HKCR\CLSID\{<CLSID>}\InprocServer32 key.
 125         if (SUCCEEDED(hr))
 126         {
 127             hr = StringCchPrintf(szSubkey, ARRAYSIZE(szSubkey),
 128                 L"CLSID\\%s\\InprocServer32", szCLSID);
 129             if (SUCCEEDED(hr))
 130             {
 131                 // Set the default value of the InprocServer32 key to the
 132                 // path of the COM module.
 133                 hr = SetHKCRRegistryKeyAndValue(szSubkey, NULL, pszModule);
 134                 if (SUCCEEDED(hr))
 135                 {
 136                     // Set the threading model of the component.
 137                     hr = SetHKCRRegistryKeyAndValue(szSubkey,
 138                         L"ThreadingModel", pszThreadModel);
 139                 }
 140             }
 141         }
 142     }
 143
 144     return hr;
 145 }
 146
 147
 148 //
 149 //   FUNCTION: UnregisterInprocServer
 150 //
 151 //   PURPOSE: Unegister the in-process component in the registry.
 152 //
 153 //   PARAMETERS:
 154 //   * clsid - Class ID of the component
 155 //
 156 //   NOTE: The function deletes the HKCR\CLSID\{<CLSID>} key in the registry.
 157 //
 158 HRESULT UnregisterInprocServer(const CLSID& clsid)
 159 {
 160     HRESULT hr = S_OK;
 161
 162     wchar_t szCLSID[MAX_PATH];
 163     StringFromGUID2(clsid, szCLSID, ARRAYSIZE(szCLSID));
 164
 165     wchar_t szSubkey[MAX_PATH];
 166
 167     // Delete the HKCR\CLSID\{<CLSID>} key.
 168     hr = StringCchPrintf(szSubkey, ARRAYSIZE(szSubkey), L"CLSID\\%s", szCLSID);
 169     if (SUCCEEDED(hr))
 170     {
 171         hr = HRESULT_FROM_WIN32(RegDeleteTree(HKEY_CLASSES_ROOT, szSubkey));
 172     }
 173
 174     return hr;
 175 }
 176
 177
 178 //
 179 //   FUNCTION: RegisterShellExtFolderCopyHookHandler
 180 //
 181 //   PURPOSE: Register the folder copy hook handler.
 182 //
 183 //   PARAMETERS:
 184 //   * pszName - The name of the copy hook handler
 185 //   * clsid - Class ID of the component
 186 //
 187 //   NOTE: The function creates the following key in the registry.
 188 //
 189 //   HKCR
 190 //   {
 191 //      NoRemove Directory
 192 //      {
 193 //          NoRemove shellex
 194 //          {
 195 //              NoRemove CopyHookHandlers
 196 //              {
 197 //                  <Name> = s '{<CLSID>}'
 198 //              }
 199 //          }
 200 //      }
 201 //   }
 202 //
 203 HRESULT RegisterShellExtFolderCopyHookHandler(PCWSTR pszName, const CLSID& clsid)
 204 {
 205     if (pszName == NULL || wcslen(pszName) == 0)
 206     {
 207         return E_INVALIDARG;
 208     }
 209
 210     wchar_t szCLSID[MAX_PATH];
 211     StringFromGUID2(clsid, szCLSID, ARRAYSIZE(szCLSID));
 212
 213     wchar_t szSubkey[MAX_PATH];
 214
 215     // Folder copy hook handlers are typically registered under the following
 216     // subkey: HKCR\Directory\shellex\CopyHookHandlers.
 217     // Create the key HKCR\Directory\shellex\CopyHookHandlers\<Name>
 218     HRESULT hr = StringCchPrintf(szSubkey, ARRAYSIZE(szSubkey),
 219         L"Directory\\shellex\\CopyHookHandlers\\%s", pszName);
 220     if (SUCCEEDED(hr))
 221     {
 222         // Set the default value of the key.
 223         hr = SetHKCRRegistryKeyAndValue(szSubkey, NULL, szCLSID);
 224     }
 225
 226     return hr;
 227 }
 228
 229
 230 //
 231 //   FUNCTION: UnregisterShellExtFolderCopyHookHandler
 232 //
 233 //   PURPOSE: Unregister the folder copy hook handler.
 234 //
 235 //   PARAMETERS:
 236 //   * pszName - The name of the copy hook handler
 237 //
 238 //   NOTE: The function removes the <Name> key under
 239 //   HKCR\Directory\shellex\CopyHookHandlers in the registry.
 240 //
 241 HRESULT UnregisterShellExtFolderCopyHookHandler(PCWSTR pszName)
 242 {
 243     if (pszName == NULL || wcslen(pszName) == 0)
 244     {
 245         return E_INVALIDARG;
 246     }
 247
 248     wchar_t szSubkey[MAX_PATH];
 249
 250     // Remove the HKCR\Directory\shellex\CopyHookHandlers\<Name> key.
 251     HRESULT hr = StringCchPrintf(szSubkey, ARRAYSIZE(szSubkey),
 252         L"Directory\\shellex\\CopyHookHandlers\\%s", pszName);
 253     if (SUCCEEDED(hr))
 254     {
 255         hr = HRESULT_FROM_WIN32(RegDeleteTree(HKEY_CLASSES_ROOT, szSubkey));
 256     }
 257
 258     return hr;
 259 }